ModelingModel

The model definition that contains details of tables, their relationships and joins, and measures.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

defaultDateFormat

Default date format

-

string

databaseName

The model's database name

-

string

modelId

The model's system ID

-

string

uuid

defaultMeasureUniqueName

Unique identifier of the default measure

-

string

displayName

The model's display name

-

string

description

A description of the model

-

string

modelType

The type of model.

-

DataFlowModelType

additionalLanguages

Additional languages in the model

-

object

serverId

The host server's name

-

string

modelingTranslation

Model translations objects.

-

ModelingTranslation

allLevelName

'All' Level Name

-

string

pchLevelTemplate

Parent Child Hierarchy Level Template

-

string

relationships

A list of the relationships between tables in the model

-

ModelingRelationship [ ]

nullMemberCaption

The value that will be presented to the end user in case of null value.

-

string

tables

A list of tables/dimensions in the model

-

ModelingTable [ ]

serverInfo

Describe the details about the server that the current model is based on.

-

ModelingServerInfo

arrange

Should auto-arrange

-

boolean

culture

The model's culture name

-

string

modelDataFlowSourceInfo

Info about the source Data Flow used to drive this model

-

ModelDataFlowSourceInfo

allMemberName

'All' Member Name

-

string

measureGroups

The model's measure groups.

-

MeasureGroup [ ]

syncColumnsSettings

settings for sync columns by schedule. defines an aggregation and visibility for each new column data type.

-

ModelSyncColumnsSettings [ ]

disableCacheMode

Should disable cache

-

boolean

isAutoIndexing

Set to true for heuristic index creation

-

boolean

Usages
  • /API2/dataSources/getDataModelStructure
  • /API3/dataSources/getModelStructure